<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>XWPFDocument (POI API Documentation)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="XWPFDocument (POI API Documentation)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/XWPFDocument.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFComment.html" title="class in org.apache.poi.xwpf.usermodel"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFFactory.html" title="class in org.apache.poi.xwpf.usermodel"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/xwpf/usermodel/XWPFDocument.html" target="_top">FRAMES</a></li>
<li><a href="XWPFDocument.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li><a href="#field_summary">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li><a href="#field_detail">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<p class="subTitle">org.apache.poi.xwpf.usermodel</p>
<h2 title="Class XWPFDocument" class="title">Class XWPFDocument</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/poi/POIXMLDocumentPart.html" title="class in org.apache.poi">org.apache.poi.POIXMLDocumentPart</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/poi/POIXMLDocument.html" title="class in org.apache.poi">org.apache.poi.POIXMLDocument</a></li>
<li>
<ul class="inheritance">
<li>org.apache.poi.xwpf.usermodel.XWPFDocument</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/poi/xwpf/usermodel/Document.html" title="interface in org.apache.poi.xwpf.usermodel">Document</a>, <a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html" title="interface in org.apache.poi.xwpf.usermodel">IBody</a></dd>
</dl>
<hr>
<br>
<pre>public class <strong>XWPFDocument</strong>
extends <a href="../../../../../org/apache/poi/POIXMLDocument.html" title="class in org.apache.poi">POIXMLDocument</a>
implements <a href="../../../../../org/apache/poi/xwpf/usermodel/Document.html" title="interface in org.apache.poi.xwpf.usermodel">Document</a>, <a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html" title="interface in org.apache.poi.xwpf.usermodel">IBody</a></pre>
<div class="block"><p>High(ish) level class for working with .docx files.</p>
 
 <p>This class tries to hide some of the complexity
  of the underlying file format, but as it's not a 
  mature and stable API yet, certain parts of the
  XML structure come through. You'll therefore almost
  certainly need to refer to the OOXML specifications
  from
  http://www.ecma-international.org/publications/standards/Ecma-376.htm
  at some point in your use.</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!--   -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/IBodyElement.html" title="interface in org.apache.poi.xwpf.usermodel">IBodyElement</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#bodyElements">bodyElements</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFComment.html" title="class in org.apache.poi.xwpf.usermodel">XWPFComment</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#comments">comments</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFSDT.html" title="class in org.apache.poi.xwpf.usermodel">XWPFSDT</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#contentControls">contentControls</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.util.Map&lt;java.lang.Integer,<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFFootnote.html" title="class in org.apache.poi.xwpf.usermodel">XWPFFootnote</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#endnotes">endnotes</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFFooter.html" title="class in org.apache.poi.xwpf.usermodel">XWPFFooter</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#footers">footers</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFFootnotes.html" title="class in org.apache.poi.xwpf.usermodel">XWPFFootnotes</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#footnotes">footnotes</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFHeader.html" title="class in org.apache.poi.xwpf.usermodel">XWPFHeader</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#headers">headers</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFHyperlink.html" title="class in org.apache.poi.xwpf.usermodel">XWPFHyperlink</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#hyperlinks">hyperlinks</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFNumbering.html" title="class in org.apache.poi.xwpf.usermodel">XWPFNumbering</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#numbering">numbering</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.util.Map&lt;java.lang.Long,java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFPictureData.html" title="class in org.apache.poi.xwpf.usermodel">XWPFPictureData</a>&gt;&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#packagePictures">packagePictures</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html" title="class in org.apache.poi.xwpf.usermodel">XWPFParagraph</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#paragraphs">paragraphs</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFPictureData.html" title="class in org.apache.poi.xwpf.usermodel">XWPFPictureData</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#pictures">pictures</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFStyles.html" title="class in org.apache.poi.xwpf.usermodel">XWPFStyles</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#styles">styles</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTable</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#tables">tables</a></strong></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.poi.POIXMLDocument">
<!--   -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.poi.<a href="../../../../../org/apache/poi/POIXMLDocument.html" title="class in org.apache.poi">POIXMLDocument</a></h3>
<code><a href="../../../../../org/apache/poi/POIXMLDocument.html#DOCUMENT_CREATOR">DOCUMENT_CREATOR</a>, <a href="../../../../../org/apache/poi/POIXMLDocument.html#OLE_OBJECT_REL_TYPE">OLE_OBJECT_REL_TYPE</a>, <a href="../../../../../org/apache/poi/POIXMLDocument.html#PACK_OBJECT_REL_TYPE">PACK_OBJECT_REL_TYPE</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.poi.POIXMLDocumentPart">
<!--   -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.poi.<a href="../../../../../org/apache/poi/POIXMLDocumentPart.html" title="class in org.apache.poi">POIXMLDocumentPart</a></h3>
<code><a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#DEFAULT_XML_OPTIONS">DEFAULT_XML_OPTIONS</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.poi.xwpf.usermodel.Document">
<!--   -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.poi.xwpf.usermodel.<a href="../../../../../org/apache/poi/xwpf/usermodel/Document.html" title="interface in org.apache.poi.xwpf.usermodel">Document</a></h3>
<code><a href="../../../../../org/apache/poi/xwpf/usermodel/Document.html#PICTURE_TYPE_BMP">PICTURE_TYPE_BMP</a>, <a href="../../../../../org/apache/poi/xwpf/usermodel/Document.html#PICTURE_TYPE_DIB">PICTURE_TYPE_DIB</a>, <a href="../../../../../org/apache/poi/xwpf/usermodel/Document.html#PICTURE_TYPE_EMF">PICTURE_TYPE_EMF</a>, <a href="../../../../../org/apache/poi/xwpf/usermodel/Document.html#PICTURE_TYPE_EPS">PICTURE_TYPE_EPS</a>, <a href="../../../../../org/apache/poi/xwpf/usermodel/Document.html#PICTURE_TYPE_GIF">PICTURE_TYPE_GIF</a>, <a href="../../../../../org/apache/poi/xwpf/usermodel/Document.html#PICTURE_TYPE_JPEG">PICTURE_TYPE_JPEG</a>, <a href="../../../../../org/apache/poi/xwpf/usermodel/Document.html#PICTURE_TYPE_PICT">PICTURE_TYPE_PICT</a>, <a href="../../../../../org/apache/poi/xwpf/usermodel/Document.html#PICTURE_TYPE_PNG">PICTURE_TYPE_PNG</a>, <a href="../../../../../org/apache/poi/xwpf/usermodel/Document.html#PICTURE_TYPE_TIFF">PICTURE_TYPE_TIFF</a>, <a href="../../../../../org/apache/poi/xwpf/usermodel/Document.html#PICTURE_TYPE_WMF">PICTURE_TYPE_WMF</a>, <a href="../../../../../org/apache/poi/xwpf/usermodel/Document.html#PICTURE_TYPE_WPG">PICTURE_TYPE_WPG</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#XWPFDocument()">XWPFDocument</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#XWPFDocument(java.io.InputStream)">XWPFDocument</a></strong>(java.io.InputStream&nbsp;is)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#XWPFDocument(org.apache.poi.openxml4j.opc.OPCPackage)">XWPFDocument</a></strong>(<a href="../../../../../org/apache/poi/openxml4j/opc/OPCPackage.html" title="class in org.apache.poi.openxml4j.opc">OPCPackage</a>&nbsp;pkg)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFFootnote.html" title="class in org.apache.poi.xwpf.usermodel">XWPFFootnote</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#addEndnote(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn)">addEndnote</a></strong>(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn&nbsp;note)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFFootnote.html" title="class in org.apache.poi.xwpf.usermodel">XWPFFootnote</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#addFootnote(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn)">addFootnote</a></strong>(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn&nbsp;note)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#addPictureData(byte[], int)">addPictureData</a></strong>(byte[]&nbsp;pictureData,
              int&nbsp;format)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#addPictureData(java.io.InputStream, int)">addPictureData</a></strong>(java.io.InputStream&nbsp;is,
              int&nbsp;format)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#commit()">commit</a></strong>()</code>
<div class="block">commit and saves the document</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFFootnotes.html" title="class in org.apache.poi.xwpf.usermodel">XWPFFootnotes</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#createFootnotes()">createFootnotes</a></strong>()</code>
<div class="block">Creates an empty footnotes element for the document if one does not already exist</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFNumbering.html" title="class in org.apache.poi.xwpf.usermodel">XWPFNumbering</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#createNumbering()">createNumbering</a></strong>()</code>
<div class="block">Creates an empty numbering if one does not already exist and sets the numbering member</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html" title="class in org.apache.poi.xwpf.usermodel">XWPFParagraph</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#createParagraph()">createParagraph</a></strong>()</code>
<div class="block">Appends a new paragraph to this document</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFStyles.html" title="class in org.apache.poi.xwpf.usermodel">XWPFStyles</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#createStyles()">createStyles</a></strong>()</code>
<div class="block">Creates an empty styles for the document if one does not already exist</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTable</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#createTable()">createTable</a></strong>()</code>
<div class="block">Create an empty table with one row and one column as default.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTable</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#createTable(int, int)">createTable</a></strong>(int&nbsp;rows,
           int&nbsp;cols)</code>
<div class="block">Create an empty table with a number of rows and cols specified</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#createTOC()">createTOC</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#enforceCommentsProtection()">enforceCommentsProtection</a></strong>()</code>
<div class="block">Enforce the Comments protection.<br/>
 In the documentProtection tag inside settings.xml file,<br/>
 it sets the value of enforcement to "1" (w:enforcement="1") <br/>
 and the value of edit to comments (w:edit="comments")<br/>
 <br/>
 sample snippet from settings.xml</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#enforceCommentsProtection(java.lang.String, org.apache.poi.poifs.crypt.HashAlgorithm)">enforceCommentsProtection</a></strong>(java.lang.String&nbsp;password,
                         <a href="../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a>&nbsp;hashAlgo)</code>
<div class="block">Enforce the Comments protection.<br/>
 <br/>
 sample snippet from settings.xml</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#enforceFillingFormsProtection()">enforceFillingFormsProtection</a></strong>()</code>
<div class="block">Enforce the Filling Forms protection.<br/>
 In the documentProtection tag inside settings.xml file, <br/>
 it sets the value of enforcement to "1" (w:enforcement="1") <br/>
 and the value of edit to forms (w:edit="forms")<br/>
 <br/>
 sample snippet from settings.xml</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#enforceFillingFormsProtection(java.lang.String, org.apache.poi.poifs.crypt.HashAlgorithm)">enforceFillingFormsProtection</a></strong>(java.lang.String&nbsp;password,
                             <a href="../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a>&nbsp;hashAlgo)</code>
<div class="block">Enforce the Filling Forms protection.<br/>
 <br/>
 sample snippet from settings.xml</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#enforceReadonlyProtection()">enforceReadonlyProtection</a></strong>()</code>
<div class="block">Enforces the readOnly protection.<br/>
 In the documentProtection tag inside settings.xml file, <br/>
 it sets the value of enforcement to "1" (w:enforcement="1") <br/>
 and the value of edit to readOnly (w:edit="readOnly")<br/>
 <br/>
 sample snippet from settings.xml</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#enforceReadonlyProtection(java.lang.String, org.apache.poi.poifs.crypt.HashAlgorithm)">enforceReadonlyProtection</a></strong>(java.lang.String&nbsp;password,
                         <a href="../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a>&nbsp;hashAlgo)</code>
<div class="block">Enforces the readOnly protection with a password.<br/>
 <br/>
 sample snippet from settings.xml</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#enforceTrackedChangesProtection()">enforceTrackedChangesProtection</a></strong>()</code>
<div class="block">Enforce the Tracked Changes protection.<br/>
 In the documentProtection tag inside settings.xml file, <br/>
 it sets the value of enforcement to "1" (w:enforcement="1") <br/>
 and the value of edit to trackedChanges (w:edit="trackedChanges")<br/>
 <br/>
 sample snippet from settings.xml</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#enforceTrackedChangesProtection(java.lang.String, org.apache.poi.poifs.crypt.HashAlgorithm)">enforceTrackedChangesProtection</a></strong>(java.lang.String&nbsp;password,
                               <a href="../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a>&nbsp;hashAlgo)</code>
<div class="block">Enforce the Tracked Changes protection.<br/>
 <br/>
 sample snippet from settings.xml</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#enforceUpdateFields()">enforceUpdateFields</a></strong>()</code>
<div class="block">Enforces fields update on document open (in Word).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../org/apache/poi/openxml4j/opc/PackagePart.html" title="class in org.apache.poi.openxml4j.opc">PackagePart</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getAllEmbedds()">getAllEmbedds</a></strong>()</code>
<div class="block">Get the document's embedded files.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFPictureData.html" title="class in org.apache.poi.xwpf.usermodel">XWPFPictureData</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getAllPackagePictures()">getAllPackagePictures</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFPictureData.html" title="class in org.apache.poi.xwpf.usermodel">XWPFPictureData</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getAllPictures()">getAllPictures</a></strong>()</code>
<div class="block">Returns all Pictures, which are referenced from the document itself.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/IBodyElement.html" title="interface in org.apache.poi.xwpf.usermodel">IBodyElement</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getBodyElements()">getBodyElements</a></strong>()</code>
<div class="block">returns an Iterator with paragraphs and tables</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Iterator&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/IBodyElement.html" title="interface in org.apache.poi.xwpf.usermodel">IBodyElement</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getBodyElementsIterator()">getBodyElementsIterator</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFComment.html" title="class in org.apache.poi.xwpf.usermodel">XWPFComment</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getCommentByID(java.lang.String)">getCommentByID</a></strong>(java.lang.String&nbsp;id)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFComment.html" title="class in org.apache.poi.xwpf.usermodel">XWPFComment</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getComments()">getComments</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.openxmlformats.schemas.wordprocessingml.x2006.main.CTDocument1</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getDocument()">getDocument</a></strong>()</code>
<div class="block">Returns the low level document base object</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFFootnote.html" title="class in org.apache.poi.xwpf.usermodel">XWPFFootnote</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getEndnoteByID(int)">getEndnoteByID</a></strong>(int&nbsp;id)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFFooter.html" title="class in org.apache.poi.xwpf.usermodel">XWPFFooter</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getFooterArray(int)">getFooterArray</a></strong>(int&nbsp;pos)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFFooter.html" title="class in org.apache.poi.xwpf.usermodel">XWPFFooter</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getFooterList()">getFooterList</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFFootnote.html" title="class in org.apache.poi.xwpf.usermodel">XWPFFootnote</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getFootnoteByID(int)">getFootnoteByID</a></strong>(int&nbsp;id)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFFootnote.html" title="class in org.apache.poi.xwpf.usermodel">XWPFFootnote</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getFootnotes()">getFootnotes</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFHeader.html" title="class in org.apache.poi.xwpf.usermodel">XWPFHeader</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getHeaderArray(int)">getHeaderArray</a></strong>(int&nbsp;pos)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/model/XWPFHeaderFooterPolicy.html" title="class in org.apache.poi.xwpf.model">XWPFHeaderFooterPolicy</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getHeaderFooterPolicy()">getHeaderFooterPolicy</a></strong>()</code>
<div class="block">Returns the policy on headers and footers, which
  also provides a way to get at them.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFHeader.html" title="class in org.apache.poi.xwpf.usermodel">XWPFHeader</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getHeaderList()">getHeaderList</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFHyperlink.html" title="class in org.apache.poi.xwpf.usermodel">XWPFHyperlink</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getHyperlinkByID(java.lang.String)">getHyperlinkByID</a></strong>(java.lang.String&nbsp;id)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFHyperlink.html" title="class in org.apache.poi.xwpf.usermodel">XWPFHyperlink</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getHyperlinks()">getHyperlinks</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html" title="class in org.apache.poi.xwpf.usermodel">XWPFParagraph</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getLastParagraph()">getLastParagraph</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getNextPicNameNumber(int)">getNextPicNameNumber</a></strong>(int&nbsp;format)</code>
<div class="block">get the next free ImageNumber</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFNumbering.html" title="class in org.apache.poi.xwpf.usermodel">XWPFNumbering</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getNumbering()">getNumbering</a></strong>()</code>
<div class="block">getNumbering</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html" title="class in org.apache.poi.xwpf.usermodel">XWPFParagraph</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getParagraph(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP)">getParagraph</a></strong>(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP&nbsp;p)</code>
<div class="block">get the paragraph with the CTP class p</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html" title="class in org.apache.poi.xwpf.usermodel">XWPFParagraph</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getParagraphArray(int)">getParagraphArray</a></strong>(int&nbsp;pos)</code>
<div class="block">Returns the paragraph that of position pos</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getParagraphPos(int)">getParagraphPos</a></strong>(int&nbsp;pos)</code>
<div class="block">Look up the paragraph at the specified position in the body elements list
 and return this paragraphs position in the paragraphs list</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html" title="class in org.apache.poi.xwpf.usermodel">XWPFParagraph</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getParagraphs()">getParagraphs</a></strong>()</code>
<div class="block">Returns the paragraph(s) that holds
  the text of the header or footer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Iterator&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html" title="class in org.apache.poi.xwpf.usermodel">XWPFParagraph</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getParagraphsIterator()">getParagraphsIterator</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/POIXMLDocumentPart.html" title="class in org.apache.poi">POIXMLDocumentPart</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getPart()">getPart</a></strong>()</code>
<div class="block">returns the Part, to which the body belongs, which you need for adding relationship to other parts
 Actually it is needed of the class XWPFTableCell.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/openxml4j/opc/PackagePart.html" title="class in org.apache.poi.openxml4j.opc">PackagePart</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getPartById(java.lang.String)">getPartById</a></strong>(java.lang.String&nbsp;id)</code>
<div class="block">Get the document part that's defined as the
  given relationship of the core document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/BodyType.html" title="enum in org.apache.poi.xwpf.usermodel">BodyType</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getPartType()">getPartType</a></strong>()</code>
<div class="block">get the PartType of the body, for example
 DOCUMENT, HEADER, FOOTER, FOOTNOTE,</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFPictureData.html" title="class in org.apache.poi.xwpf.usermodel">XWPFPictureData</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getPictureDataByID(java.lang.String)">getPictureDataByID</a></strong>(java.lang.String&nbsp;blipID)</code>
<div class="block">returns the PictureData by blipID</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getPosOfParagraph(org.apache.poi.xwpf.usermodel.XWPFParagraph)">getPosOfParagraph</a></strong>(<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html" title="class in org.apache.poi.xwpf.usermodel">XWPFParagraph</a>&nbsp;p)</code>
<div class="block">Get the position of the paragraph, within the list
  of all the body elements.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getPosOfTable(org.apache.poi.xwpf.usermodel.XWPFTable)">getPosOfTable</a></strong>(<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTable</a>&nbsp;t)</code>
<div class="block">Get the position of the table, within the list of
  all the body elements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.openxmlformats.schemas.wordprocessingml.x2006.main.CTStyles</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getStyle()">getStyle</a></strong>()</code>
<div class="block">Returns the styles object used</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFStyles.html" title="class in org.apache.poi.xwpf.usermodel">XWPFStyles</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getStyles()">getStyles</a></strong>()</code>
<div class="block">get Styles</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTable</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getTable(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl)">getTable</a></strong>(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl&nbsp;ctTbl)</code>
<div class="block">get a table by its CTTbl-Object</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTable</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getTableArray(int)">getTableArray</a></strong>(int&nbsp;pos)</code>
<div class="block">Returns the table at position pos</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTableCell.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTableCell</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getTableCell(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTc)">getTableCell</a></strong>(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTc&nbsp;cell)</code>
<div class="block">get the TableCell which belongs to the TableCell</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getTablePos(int)">getTablePos</a></strong>(int&nbsp;pos)</code>
<div class="block">get with the position of a table in the bodyelement array list 
 the position of this table in the table array list</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTable</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getTables()">getTables</a></strong>()</code>
<div class="block">Return the table(s) that holds the text
  of the IBodyPart, for complex cases
  where a paragraph isn't used.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Iterator&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTable</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getTablesIterator()">getTablesIterator</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getTblStyle(org.apache.poi.xwpf.usermodel.XWPFTable)">getTblStyle</a></strong>(<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTable</a>&nbsp;table)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html" title="class in org.apache.poi.xwpf.usermodel">XWPFDocument</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#getXWPFDocument()">getXWPFDocument</a></strong>()</code>
<div class="block">Return XWPFDocument</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html" title="class in org.apache.poi.xwpf.usermodel">XWPFParagraph</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#insertNewParagraph(org.apache.xmlbeans.XmlCursor)">insertNewParagraph</a></strong>(org.apache.xmlbeans.XmlCursor&nbsp;cursor)</code>
<div class="block">Add a new paragraph at position of the cursor.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTable</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#insertNewTbl(org.apache.xmlbeans.XmlCursor)">insertNewTbl</a></strong>(org.apache.xmlbeans.XmlCursor&nbsp;cursor)</code>
<div class="block">inserts a new Table at the cursor position.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#insertTable(int, org.apache.poi.xwpf.usermodel.XWPFTable)">insertTable</a></strong>(int&nbsp;pos,
           <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTable</a>&nbsp;table)</code>
<div class="block">inserts an existing XWPFTable to the arrays bodyElements and tables</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#isEnforcedCommentsProtection()">isEnforcedCommentsProtection</a></strong>()</code>
<div class="block">Verifies that the documentProtection tag in settings.xml file <br/>
 specifies that the protection is enforced (w:enforcement="1") <br/>
 and that the kind of protection is comments (w:edit="comments")<br/>
 <br/>
 sample snippet from settings.xml</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#isEnforcedFillingFormsProtection()">isEnforcedFillingFormsProtection</a></strong>()</code>
<div class="block">Verifies that the documentProtection tag in settings.xml file <br/>
 specifies that the protection is enforced (w:enforcement="1") <br/>
 and that the kind of protection is forms (w:edit="forms")<br/>
 <br/>
 sample snippet from settings.xml</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#isEnforcedReadonlyProtection()">isEnforcedReadonlyProtection</a></strong>()</code>
<div class="block">Verifies that the documentProtection tag in settings.xml file <br/>
 specifies that the protection is enforced (w:enforcement="1") <br/>
 and that the kind of protection is readOnly (w:edit="readOnly")<br/>
 <br/>
 sample snippet from settings.xml</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#isEnforcedTrackedChangesProtection()">isEnforcedTrackedChangesProtection</a></strong>()</code>
<div class="block">Verifies that the documentProtection tag in settings.xml file <br/>
 specifies that the protection is enforced (w:enforcement="1") <br/>
 and that the kind of protection is trackedChanges (w:edit="trackedChanges")<br/>
 <br/>
 sample snippet from settings.xml</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#isEnforcedUpdateFields()">isEnforcedUpdateFields</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#isTrackRevisions()">isTrackRevisions</a></strong>()</code>
<div class="block">Check if revision tracking is turned on.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static <a href="../../../../../org/apache/poi/openxml4j/opc/OPCPackage.html" title="class in org.apache.poi.openxml4j.opc">OPCPackage</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#newPackage()">newPackage</a></strong>()</code>
<div class="block">Create a new WordProcessingML package and setup the default minimal content</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#onDocumentCreate()">onDocumentCreate</a></strong>()</code>
<div class="block">Create a new CTWorkbook with all values set to default</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#onDocumentRead()">onDocumentRead</a></strong>()</code>
<div class="block">Fired when a package part is read</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#removeBodyElement(int)">removeBodyElement</a></strong>(int&nbsp;pos)</code>
<div class="block">remove a BodyElement from bodyElements array list</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#removeProtectionEnforcement()">removeProtectionEnforcement</a></strong>()</code>
<div class="block">Remove protection enforcement.<br/>
 In the documentProtection tag inside settings.xml file <br/>
 it sets the value of enforcement to "0" (w:enforcement="0") <br/></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#setParagraph(org.apache.poi.xwpf.usermodel.XWPFParagraph, int)">setParagraph</a></strong>(<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html" title="class in org.apache.poi.xwpf.usermodel">XWPFParagraph</a>&nbsp;paragraph,
            int&nbsp;pos)</code>
<div class="block">copies content of a paragraph to a existing paragraph in the list paragraphs at position pos</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#setTable(int, org.apache.poi.xwpf.usermodel.XWPFTable)">setTable</a></strong>(int&nbsp;pos,
        <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTable</a>&nbsp;table)</code>
<div class="block">Replace content of table in array tables at position pos with a</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#setTrackRevisions(boolean)">setTrackRevisions</a></strong>(boolean&nbsp;enable)</code>
<div class="block">Enable or disable revision tracking.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html#validateProtectionPassword(java.lang.String)">validateProtectionPassword</a></strong>(java.lang.String&nbsp;password)</code>
<div class="block">Validates the existing password</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.POIXMLDocument">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.poi.<a href="../../../../../org/apache/poi/POIXMLDocument.html" title="class in org.apache.poi">POIXMLDocument</a></h3>
<code><a href="../../../../../org/apache/poi/POIXMLDocument.html#close()">close</a>, <a href="../../../../../org/apache/poi/POIXMLDocument.html#getCorePart()">getCorePart</a>, <a href="../../../../../org/apache/poi/POIXMLDocument.html#getPackage()">getPackage</a>, <a href="../../../../../org/apache/poi/POIXMLDocument.html#getProperties()">getProperties</a>, <a href="../../../../../org/apache/poi/POIXMLDocument.html#getRelatedByType(java.lang.String)">getRelatedByType</a>, <a href="../../../../../org/apache/poi/POIXMLDocument.html#hasOOXMLHeader(java.io.InputStream)">hasOOXMLHeader</a>, <a href="../../../../../org/apache/poi/POIXMLDocument.html#load(org.apache.poi.POIXMLFactory)">load</a>, <a href="../../../../../org/apache/poi/POIXMLDocument.html#openPackage(java.lang.String)">openPackage</a>, <a href="../../../../../org/apache/poi/POIXMLDocument.html#write(java.io.OutputStream)">write</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.POIXMLDocumentPart">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.poi.<a href="../../../../../org/apache/poi/POIXMLDocumentPart.html" title="class in org.apache.poi">POIXMLDocumentPart</a></h3>
<code><a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#addRelation(java.lang.String, org.apache.poi.POIXMLDocumentPart)">addRelation</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#createRelationship(org.apache.poi.POIXMLRelation, org.apache.poi.POIXMLFactory)">createRelationship</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#createRelationship(org.apache.poi.POIXMLRelation, org.apache.poi.POIXMLFactory, int)">createRelationship</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#createRelationship(org.apache.poi.POIXMLRelation, org.apache.poi.POIXMLFactory, int, boolean)">createRelationship</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#getPackagePart()">getPackagePart</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#getPackageRelationship()">getPackageRelationship</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#getParent()">getParent</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#getRelationById(java.lang.String)">getRelationById</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#getRelationId(org.apache.poi.POIXMLDocumentPart)">getRelationId</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#getRelations()">getRelations</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#getTargetPart(org.apache.poi.openxml4j.opc.PackageRelationship)">getTargetPart</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#onDocumentRemove()">onDocumentRemove</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#onSave(java.util.Set)">onSave</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#prepareForCommit()">prepareForCommit</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#read(org.apache.poi.POIXMLFactory, java.util.Map)">read</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#rebase(org.apache.poi.openxml4j.opc.OPCPackage)">rebase</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#removeRelation(org.apache.poi.POIXMLDocumentPart)">removeRelation</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#removeRelation(org.apache.poi.POIXMLDocumentPart, boolean)">removeRelation</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#toString()">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!--   -->
</a>
<h3>Field Detail</h3>
<a name="footers">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>footers</h4>
<pre>protected&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFFooter.html" title="class in org.apache.poi.xwpf.usermodel">XWPFFooter</a>&gt; footers</pre>
</li>
</ul>
<a name="headers">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>headers</h4>
<pre>protected&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFHeader.html" title="class in org.apache.poi.xwpf.usermodel">XWPFHeader</a>&gt; headers</pre>
</li>
</ul>
<a name="comments">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>comments</h4>
<pre>protected&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFComment.html" title="class in org.apache.poi.xwpf.usermodel">XWPFComment</a>&gt; comments</pre>
</li>
</ul>
<a name="hyperlinks">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hyperlinks</h4>
<pre>protected&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFHyperlink.html" title="class in org.apache.poi.xwpf.usermodel">XWPFHyperlink</a>&gt; hyperlinks</pre>
</li>
</ul>
<a name="paragraphs">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>paragraphs</h4>
<pre>protected&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html" title="class in org.apache.poi.xwpf.usermodel">XWPFParagraph</a>&gt; paragraphs</pre>
</li>
</ul>
<a name="tables">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tables</h4>
<pre>protected&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTable</a>&gt; tables</pre>
</li>
</ul>
<a name="contentControls">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contentControls</h4>
<pre>protected&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFSDT.html" title="class in org.apache.poi.xwpf.usermodel">XWPFSDT</a>&gt; contentControls</pre>
</li>
</ul>
<a name="bodyElements">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bodyElements</h4>
<pre>protected&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/IBodyElement.html" title="interface in org.apache.poi.xwpf.usermodel">IBodyElement</a>&gt; bodyElements</pre>
</li>
</ul>
<a name="pictures">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pictures</h4>
<pre>protected&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFPictureData.html" title="class in org.apache.poi.xwpf.usermodel">XWPFPictureData</a>&gt; pictures</pre>
</li>
</ul>
<a name="packagePictures">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>packagePictures</h4>
<pre>protected&nbsp;java.util.Map&lt;java.lang.Long,java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFPictureData.html" title="class in org.apache.poi.xwpf.usermodel">XWPFPictureData</a>&gt;&gt; packagePictures</pre>
</li>
</ul>
<a name="endnotes">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>endnotes</h4>
<pre>protected&nbsp;java.util.Map&lt;java.lang.Integer,<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFFootnote.html" title="class in org.apache.poi.xwpf.usermodel">XWPFFootnote</a>&gt; endnotes</pre>
</li>
</ul>
<a name="numbering">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>numbering</h4>
<pre>protected&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFNumbering.html" title="class in org.apache.poi.xwpf.usermodel">XWPFNumbering</a> numbering</pre>
</li>
</ul>
<a name="styles">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>styles</h4>
<pre>protected&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFStyles.html" title="class in org.apache.poi.xwpf.usermodel">XWPFStyles</a> styles</pre>
</li>
</ul>
<a name="footnotes">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>footnotes</h4>
<pre>protected&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFFootnotes.html" title="class in org.apache.poi.xwpf.usermodel">XWPFFootnotes</a> footnotes</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="XWPFDocument(org.apache.poi.openxml4j.opc.OPCPackage)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XWPFDocument</h4>
<pre>public&nbsp;XWPFDocument(<a href="../../../../../org/apache/poi/openxml4j/opc/OPCPackage.html" title="class in org.apache.poi.openxml4j.opc">OPCPackage</a>&nbsp;pkg)
             throws java.io.IOException</pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="XWPFDocument(java.io.InputStream)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XWPFDocument</h4>
<pre>public&nbsp;XWPFDocument(java.io.InputStream&nbsp;is)
             throws java.io.IOException</pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="XWPFDocument()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>XWPFDocument</h4>
<pre>public&nbsp;XWPFDocument()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="onDocumentRead()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onDocumentRead</h4>
<pre>protected&nbsp;void&nbsp;onDocumentRead()
                       throws java.io.IOException</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#onDocumentRead()">POIXMLDocumentPart</a></code></strong></div>
<div class="block">Fired when a package part is read</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#onDocumentRead()">onDocumentRead</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/poi/POIXMLDocumentPart.html" title="class in org.apache.poi">POIXMLDocumentPart</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="newPackage()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newPackage</h4>
<pre>protected static&nbsp;<a href="../../../../../org/apache/poi/openxml4j/opc/OPCPackage.html" title="class in org.apache.poi.openxml4j.opc">OPCPackage</a>&nbsp;newPackage()</pre>
<div class="block">Create a new WordProcessingML package and setup the default minimal content</div>
</li>
</ul>
<a name="onDocumentCreate()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onDocumentCreate</h4>
<pre>protected&nbsp;void&nbsp;onDocumentCreate()</pre>
<div class="block">Create a new CTWorkbook with all values set to default</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#onDocumentCreate()">onDocumentCreate</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/poi/POIXMLDocumentPart.html" title="class in org.apache.poi">POIXMLDocumentPart</a></code></dd>
</dl>
</li>
</ul>
<a name="getDocument()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDocument</h4>
<pre><a href="../../../../../org/apache/poi/util/Internal.html" title="annotation in org.apache.poi.util">@Internal</a>
public&nbsp;org.openxmlformats.schemas.wordprocessingml.x2006.main.CTDocument1&nbsp;getDocument()</pre>
<div class="block">Returns the low level document base object</div>
</li>
</ul>
<a name="getBodyElements()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBodyElements</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/IBodyElement.html" title="interface in org.apache.poi.xwpf.usermodel">IBodyElement</a>&gt;&nbsp;getBodyElements()</pre>
<div class="block">returns an Iterator with paragraphs and tables</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#getBodyElements()">getBodyElements</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html" title="interface in org.apache.poi.xwpf.usermodel">IBody</a></code></dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#getBodyElements()"><code>IBody.getBodyElements()</code></a></dd></dl>
</li>
</ul>
<a name="getBodyElementsIterator()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBodyElementsIterator</h4>
<pre>public&nbsp;java.util.Iterator&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/IBodyElement.html" title="interface in org.apache.poi.xwpf.usermodel">IBodyElement</a>&gt;&nbsp;getBodyElementsIterator()</pre>
</li>
</ul>
<a name="getParagraphs()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParagraphs</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html" title="class in org.apache.poi.xwpf.usermodel">XWPFParagraph</a>&gt;&nbsp;getParagraphs()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#getParagraphs()">IBody</a></code></strong></div>
<div class="block">Returns the paragraph(s) that holds
  the text of the header or footer.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#getParagraphs()">getParagraphs</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html" title="interface in org.apache.poi.xwpf.usermodel">IBody</a></code></dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#getParagraphs()"><code>IBody.getParagraphs()</code></a></dd></dl>
</li>
</ul>
<a name="getTables()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTables</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTable</a>&gt;&nbsp;getTables()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#getTables()">IBody</a></code></strong></div>
<div class="block">Return the table(s) that holds the text
  of the IBodyPart, for complex cases
  where a paragraph isn't used.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#getTables()">getTables</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html" title="interface in org.apache.poi.xwpf.usermodel">IBody</a></code></dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#getTables()"><code>IBody.getTables()</code></a></dd></dl>
</li>
</ul>
<a name="getTableArray(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTableArray</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTable</a>&nbsp;getTableArray(int&nbsp;pos)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#getTableArray(int)">IBody</a></code></strong></div>
<div class="block">Returns the table at position pos</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#getTableArray(int)">getTableArray</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html" title="interface in org.apache.poi.xwpf.usermodel">IBody</a></code></dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#getTableArray(int)"><code>IBody.getTableArray(int)</code></a></dd></dl>
</li>
</ul>
<a name="getFooterList()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFooterList</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFFooter.html" title="class in org.apache.poi.xwpf.usermodel">XWPFFooter</a>&gt;&nbsp;getFooterList()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>the list of footers</dd></dl>
</li>
</ul>
<a name="getFooterArray(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFooterArray</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFFooter.html" title="class in org.apache.poi.xwpf.usermodel">XWPFFooter</a>&nbsp;getFooterArray(int&nbsp;pos)</pre>
</li>
</ul>
<a name="getHeaderList()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeaderList</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFHeader.html" title="class in org.apache.poi.xwpf.usermodel">XWPFHeader</a>&gt;&nbsp;getHeaderList()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>the list of headers</dd></dl>
</li>
</ul>
<a name="getHeaderArray(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeaderArray</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFHeader.html" title="class in org.apache.poi.xwpf.usermodel">XWPFHeader</a>&nbsp;getHeaderArray(int&nbsp;pos)</pre>
</li>
</ul>
<a name="getTblStyle(org.apache.poi.xwpf.usermodel.XWPFTable)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTblStyle</h4>
<pre>public&nbsp;java.lang.String&nbsp;getTblStyle(<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTable</a>&nbsp;table)</pre>
</li>
</ul>
<a name="getHyperlinkByID(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHyperlinkByID</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFHyperlink.html" title="class in org.apache.poi.xwpf.usermodel">XWPFHyperlink</a>&nbsp;getHyperlinkByID(java.lang.String&nbsp;id)</pre>
</li>
</ul>
<a name="getFootnoteByID(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFootnoteByID</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFFootnote.html" title="class in org.apache.poi.xwpf.usermodel">XWPFFootnote</a>&nbsp;getFootnoteByID(int&nbsp;id)</pre>
</li>
</ul>
<a name="getEndnoteByID(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEndnoteByID</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFFootnote.html" title="class in org.apache.poi.xwpf.usermodel">XWPFFootnote</a>&nbsp;getEndnoteByID(int&nbsp;id)</pre>
</li>
</ul>
<a name="getFootnotes()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFootnotes</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFFootnote.html" title="class in org.apache.poi.xwpf.usermodel">XWPFFootnote</a>&gt;&nbsp;getFootnotes()</pre>
</li>
</ul>
<a name="getHyperlinks()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHyperlinks</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFHyperlink.html" title="class in org.apache.poi.xwpf.usermodel">XWPFHyperlink</a>[]&nbsp;getHyperlinks()</pre>
</li>
</ul>
<a name="getCommentByID(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCommentByID</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFComment.html" title="class in org.apache.poi.xwpf.usermodel">XWPFComment</a>&nbsp;getCommentByID(java.lang.String&nbsp;id)</pre>
</li>
</ul>
<a name="getComments()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getComments</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFComment.html" title="class in org.apache.poi.xwpf.usermodel">XWPFComment</a>[]&nbsp;getComments()</pre>
</li>
</ul>
<a name="getPartById(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPartById</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/openxml4j/opc/PackagePart.html" title="class in org.apache.poi.openxml4j.opc">PackagePart</a>&nbsp;getPartById(java.lang.String&nbsp;id)</pre>
<div class="block">Get the document part that's defined as the
  given relationship of the core document.</div>
</li>
</ul>
<a name="getHeaderFooterPolicy()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeaderFooterPolicy</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/model/XWPFHeaderFooterPolicy.html" title="class in org.apache.poi.xwpf.model">XWPFHeaderFooterPolicy</a>&nbsp;getHeaderFooterPolicy()</pre>
<div class="block">Returns the policy on headers and footers, which
  also provides a way to get at them.</div>
</li>
</ul>
<a name="getStyle()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStyle</h4>
<pre><a href="../../../../../org/apache/poi/util/Internal.html" title="annotation in org.apache.poi.util">@Internal</a>
public&nbsp;org.openxmlformats.schemas.wordprocessingml.x2006.main.CTStyles&nbsp;getStyle()
                                                                         throws org.apache.xmlbeans.XmlException,
                                                                                java.io.IOException</pre>
<div class="block">Returns the styles object used</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>org.apache.xmlbeans.XmlException</code></dd>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="getAllEmbedds()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllEmbedds</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/openxml4j/opc/PackagePart.html" title="class in org.apache.poi.openxml4j.opc">PackagePart</a>&gt;&nbsp;getAllEmbedds()
                                          throws <a href="../../../../../org/apache/poi/openxml4j/exceptions/OpenXML4JException.html" title="class in org.apache.poi.openxml4j.exceptions">OpenXML4JException</a></pre>
<div class="block">Get the document's embedded files.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/POIXMLDocument.html#getAllEmbedds()">getAllEmbedds</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/poi/POIXMLDocument.html" title="class in org.apache.poi">POIXMLDocument</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/poi/openxml4j/exceptions/OpenXML4JException.html" title="class in org.apache.poi.openxml4j.exceptions">OpenXML4JException</a></code></dd></dl>
</li>
</ul>
<a name="getParagraphPos(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParagraphPos</h4>
<pre>public&nbsp;int&nbsp;getParagraphPos(int&nbsp;pos)</pre>
<div class="block">Look up the paragraph at the specified position in the body elements list
 and return this paragraphs position in the paragraphs list</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - The position of the relevant paragraph in the body elements
            list</dd>
<dt><span class="strong">Returns:</span></dt><dd>the position of the paragraph in the paragraphs list, if there is
         a paragraph at the position in the bodyelements list. Else it
         will return -1</dd></dl>
</li>
</ul>
<a name="getTablePos(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTablePos</h4>
<pre>public&nbsp;int&nbsp;getTablePos(int&nbsp;pos)</pre>
<div class="block">get with the position of a table in the bodyelement array list 
 the position of this table in the table array list</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - position of the table in the bodyelement array list</dd>
<dt><span class="strong">Returns:</span></dt><dd>if there is a table at the position in the bodyelement array list,
         else it will return null.</dd></dl>
</li>
</ul>
<a name="insertNewParagraph(org.apache.xmlbeans.XmlCursor)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>insertNewParagraph</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html" title="class in org.apache.poi.xwpf.usermodel">XWPFParagraph</a>&nbsp;insertNewParagraph(org.apache.xmlbeans.XmlCursor&nbsp;cursor)</pre>
<div class="block">Add a new paragraph at position of the cursor. The cursor must be on the
 <code>XmlCursor.TokenType.START</code> tag of an subelement
 of the documents body. When this method is done, the cursor passed as
 parameter points to the <code>XmlCursor.TokenType.END</code>
 of the newly inserted paragraph.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#insertNewParagraph(org.apache.xmlbeans.XmlCursor)">insertNewParagraph</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html" title="interface in org.apache.poi.xwpf.usermodel">IBody</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>cursor</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>the <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html" title="class in org.apache.poi.xwpf.usermodel"><code>XWPFParagraph</code></a> object representing the newly inserted
         CTP object</dd></dl>
</li>
</ul>
<a name="insertNewTbl(org.apache.xmlbeans.XmlCursor)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>insertNewTbl</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTable</a>&nbsp;insertNewTbl(org.apache.xmlbeans.XmlCursor&nbsp;cursor)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#insertNewTbl(org.apache.xmlbeans.XmlCursor)">IBody</a></code></strong></div>
<div class="block">inserts a new Table at the cursor position.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#insertNewTbl(org.apache.xmlbeans.XmlCursor)">insertNewTbl</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html" title="interface in org.apache.poi.xwpf.usermodel">IBody</a></code></dd>
</dl>
</li>
</ul>
<a name="getPosOfParagraph(org.apache.poi.xwpf.usermodel.XWPFParagraph)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPosOfParagraph</h4>
<pre>public&nbsp;int&nbsp;getPosOfParagraph(<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html" title="class in org.apache.poi.xwpf.usermodel">XWPFParagraph</a>&nbsp;p)</pre>
<div class="block">Get the position of the paragraph, within the list
  of all the body elements.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>p</code> - The paragraph to find</dd>
<dt><span class="strong">Returns:</span></dt><dd>The location, or -1 if the paragraph couldn't be found</dd></dl>
</li>
</ul>
<a name="getPosOfTable(org.apache.poi.xwpf.usermodel.XWPFTable)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPosOfTable</h4>
<pre>public&nbsp;int&nbsp;getPosOfTable(<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTable</a>&nbsp;t)</pre>
<div class="block">Get the position of the table, within the list of
  all the body elements.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>t</code> - The table to find</dd>
<dt><span class="strong">Returns:</span></dt><dd>The location, or -1 if the table couldn't be found</dd></dl>
</li>
</ul>
<a name="commit()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commit</h4>
<pre>protected&nbsp;void&nbsp;commit()
               throws java.io.IOException</pre>
<div class="block">commit and saves the document</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#commit()">commit</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/poi/POIXMLDocumentPart.html" title="class in org.apache.poi">POIXMLDocumentPart</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="createParagraph()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createParagraph</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html" title="class in org.apache.poi.xwpf.usermodel">XWPFParagraph</a>&nbsp;createParagraph()</pre>
<div class="block">Appends a new paragraph to this document</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a new paragraph</dd></dl>
</li>
</ul>
<a name="createNumbering()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createNumbering</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFNumbering.html" title="class in org.apache.poi.xwpf.usermodel">XWPFNumbering</a>&nbsp;createNumbering()</pre>
<div class="block">Creates an empty numbering if one does not already exist and sets the numbering member</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>numbering</dd></dl>
</li>
</ul>
<a name="createStyles()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createStyles</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFStyles.html" title="class in org.apache.poi.xwpf.usermodel">XWPFStyles</a>&nbsp;createStyles()</pre>
<div class="block">Creates an empty styles for the document if one does not already exist</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>styles</dd></dl>
</li>
</ul>
<a name="createFootnotes()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createFootnotes</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFFootnotes.html" title="class in org.apache.poi.xwpf.usermodel">XWPFFootnotes</a>&nbsp;createFootnotes()</pre>
<div class="block">Creates an empty footnotes element for the document if one does not already exist</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>footnotes</dd></dl>
</li>
</ul>
<a name="addFootnote(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFootnote</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFFootnote.html" title="class in org.apache.poi.xwpf.usermodel">XWPFFootnote</a>&nbsp;addFootnote(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn&nbsp;note)</pre>
</li>
</ul>
<a name="addEndnote(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addEndnote</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFFootnote.html" title="class in org.apache.poi.xwpf.usermodel">XWPFFootnote</a>&nbsp;addEndnote(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn&nbsp;note)</pre>
</li>
</ul>
<a name="removeBodyElement(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeBodyElement</h4>
<pre>public&nbsp;boolean&nbsp;removeBodyElement(int&nbsp;pos)</pre>
<div class="block">remove a BodyElement from bodyElements array list</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>true if removing was successfully, else return false</dd></dl>
</li>
</ul>
<a name="setParagraph(org.apache.poi.xwpf.usermodel.XWPFParagraph, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setParagraph</h4>
<pre>public&nbsp;void&nbsp;setParagraph(<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html" title="class in org.apache.poi.xwpf.usermodel">XWPFParagraph</a>&nbsp;paragraph,
                int&nbsp;pos)</pre>
<div class="block">copies content of a paragraph to a existing paragraph in the list paragraphs at position pos</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>paragraph</code> - </dd><dd><code>pos</code> - </dd></dl>
</li>
</ul>
<a name="getLastParagraph()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLastParagraph</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html" title="class in org.apache.poi.xwpf.usermodel">XWPFParagraph</a>&nbsp;getLastParagraph()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>the LastParagraph of the document</dd></dl>
</li>
</ul>
<a name="createTable()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createTable</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTable</a>&nbsp;createTable()</pre>
<div class="block">Create an empty table with one row and one column as default.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a new table</dd></dl>
</li>
</ul>
<a name="createTable(int, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createTable</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTable</a>&nbsp;createTable(int&nbsp;rows,
                    int&nbsp;cols)</pre>
<div class="block">Create an empty table with a number of rows and cols specified</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rows</code> - </dd><dd><code>cols</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>table</dd></dl>
</li>
</ul>
<a name="createTOC()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createTOC</h4>
<pre>public&nbsp;void&nbsp;createTOC()</pre>
</li>
</ul>
<a name="setTable(int, org.apache.poi.xwpf.usermodel.XWPFTable)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTable</h4>
<pre>public&nbsp;void&nbsp;setTable(int&nbsp;pos,
            <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTable</a>&nbsp;table)</pre>
<div class="block">Replace content of table in array tables at position pos with a</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - </dd><dd><code>table</code> - </dd></dl>
</li>
</ul>
<a name="isEnforcedReadonlyProtection()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEnforcedReadonlyProtection</h4>
<pre>public&nbsp;boolean&nbsp;isEnforcedReadonlyProtection()</pre>
<div class="block">Verifies that the documentProtection tag in settings.xml file <br/>
 specifies that the protection is enforced (w:enforcement="1") <br/>
 and that the kind of protection is readOnly (w:edit="readOnly")<br/>
 <br/>
 sample snippet from settings.xml
 <pre>
     &lt;w:settings  ... &gt;
         &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot;/&gt;
 </pre></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if documentProtection is enforced with option readOnly</dd></dl>
</li>
</ul>
<a name="isEnforcedFillingFormsProtection()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEnforcedFillingFormsProtection</h4>
<pre>public&nbsp;boolean&nbsp;isEnforcedFillingFormsProtection()</pre>
<div class="block">Verifies that the documentProtection tag in settings.xml file <br/>
 specifies that the protection is enforced (w:enforcement="1") <br/>
 and that the kind of protection is forms (w:edit="forms")<br/>
 <br/>
 sample snippet from settings.xml
 <pre>
     &lt;w:settings  ... &gt;
         &lt;w:documentProtection w:edit=&quot;forms&quot; w:enforcement=&quot;1&quot;/&gt;
 </pre></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if documentProtection is enforced with option forms</dd></dl>
</li>
</ul>
<a name="isEnforcedCommentsProtection()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEnforcedCommentsProtection</h4>
<pre>public&nbsp;boolean&nbsp;isEnforcedCommentsProtection()</pre>
<div class="block">Verifies that the documentProtection tag in settings.xml file <br/>
 specifies that the protection is enforced (w:enforcement="1") <br/>
 and that the kind of protection is comments (w:edit="comments")<br/>
 <br/>
 sample snippet from settings.xml
 <pre>
     &lt;w:settings  ... &gt;
         &lt;w:documentProtection w:edit=&quot;comments&quot; w:enforcement=&quot;1&quot;/&gt;
 </pre></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if documentProtection is enforced with option comments</dd></dl>
</li>
</ul>
<a name="isEnforcedTrackedChangesProtection()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEnforcedTrackedChangesProtection</h4>
<pre>public&nbsp;boolean&nbsp;isEnforcedTrackedChangesProtection()</pre>
<div class="block">Verifies that the documentProtection tag in settings.xml file <br/>
 specifies that the protection is enforced (w:enforcement="1") <br/>
 and that the kind of protection is trackedChanges (w:edit="trackedChanges")<br/>
 <br/>
 sample snippet from settings.xml
 <pre>
     &lt;w:settings  ... &gt;
         &lt;w:documentProtection w:edit=&quot;trackedChanges&quot; w:enforcement=&quot;1&quot;/&gt;
 </pre></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if documentProtection is enforced with option trackedChanges</dd></dl>
</li>
</ul>
<a name="isEnforcedUpdateFields()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEnforcedUpdateFields</h4>
<pre>public&nbsp;boolean&nbsp;isEnforcedUpdateFields()</pre>
</li>
</ul>
<a name="enforceReadonlyProtection()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enforceReadonlyProtection</h4>
<pre>public&nbsp;void&nbsp;enforceReadonlyProtection()</pre>
<div class="block">Enforces the readOnly protection.<br/>
 In the documentProtection tag inside settings.xml file, <br/>
 it sets the value of enforcement to "1" (w:enforcement="1") <br/>
 and the value of edit to readOnly (w:edit="readOnly")<br/>
 <br/>
 sample snippet from settings.xml
 <pre>
     &lt;w:settings  ... &gt;
         &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot;/&gt;
 </pre></div>
</li>
</ul>
<a name="enforceReadonlyProtection(java.lang.String, org.apache.poi.poifs.crypt.HashAlgorithm)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enforceReadonlyProtection</h4>
<pre>public&nbsp;void&nbsp;enforceReadonlyProtection(java.lang.String&nbsp;password,
                             <a href="../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a>&nbsp;hashAlgo)</pre>
<div class="block">Enforces the readOnly protection with a password.<br/>
 <br/>
 sample snippet from settings.xml
 <pre>
   &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot; 
       w:cryptProviderType=&quot;rsaAES&quot; w:cryptAlgorithmClass=&quot;hash&quot;
       w:cryptAlgorithmType=&quot;typeAny&quot; w:cryptAlgorithmSid=&quot;14&quot;
       w:cryptSpinCount=&quot;100000&quot; w:hash=&quot;...&quot; w:salt=&quot;....&quot;
   /&gt;
 </pre></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>password</code> - the plaintext password, if null no password will be applied</dd><dd><code>hashAlgo</code> - the hash algorithm - only md2, m5, sha1, sha256, sha384 and sha512 are supported.
   if null, it will default default to sha1</dd></dl>
</li>
</ul>
<a name="enforceFillingFormsProtection()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enforceFillingFormsProtection</h4>
<pre>public&nbsp;void&nbsp;enforceFillingFormsProtection()</pre>
<div class="block">Enforce the Filling Forms protection.<br/>
 In the documentProtection tag inside settings.xml file, <br/>
 it sets the value of enforcement to "1" (w:enforcement="1") <br/>
 and the value of edit to forms (w:edit="forms")<br/>
 <br/>
 sample snippet from settings.xml
 <pre>
     &lt;w:settings  ... &gt;
         &lt;w:documentProtection w:edit=&quot;forms&quot; w:enforcement=&quot;1&quot;/&gt;
 </pre></div>
</li>
</ul>
<a name="enforceFillingFormsProtection(java.lang.String, org.apache.poi.poifs.crypt.HashAlgorithm)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enforceFillingFormsProtection</h4>
<pre>public&nbsp;void&nbsp;enforceFillingFormsProtection(java.lang.String&nbsp;password,
                                 <a href="../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a>&nbsp;hashAlgo)</pre>
<div class="block">Enforce the Filling Forms protection.<br/>
 <br/>
 sample snippet from settings.xml
 <pre>
   &lt;w:documentProtection w:edit=&quot;forms&quot; w:enforcement=&quot;1&quot; 
       w:cryptProviderType=&quot;rsaAES&quot; w:cryptAlgorithmClass=&quot;hash&quot;
       w:cryptAlgorithmType=&quot;typeAny&quot; w:cryptAlgorithmSid=&quot;14&quot;
       w:cryptSpinCount=&quot;100000&quot; w:hash=&quot;...&quot; w:salt=&quot;....&quot;
   /&gt;
 </pre></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>password</code> - the plaintext password, if null no password will be applied</dd><dd><code>hashAlgo</code> - the hash algorithm - only md2, m5, sha1, sha256, sha384 and sha512 are supported.
   if null, it will default default to sha1</dd></dl>
</li>
</ul>
<a name="enforceCommentsProtection()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enforceCommentsProtection</h4>
<pre>public&nbsp;void&nbsp;enforceCommentsProtection()</pre>
<div class="block">Enforce the Comments protection.<br/>
 In the documentProtection tag inside settings.xml file,<br/>
 it sets the value of enforcement to "1" (w:enforcement="1") <br/>
 and the value of edit to comments (w:edit="comments")<br/>
 <br/>
 sample snippet from settings.xml
 <pre>
     &lt;w:settings  ... &gt;
         &lt;w:documentProtection w:edit=&quot;comments&quot; w:enforcement=&quot;1&quot;/&gt;
 </pre></div>
</li>
</ul>
<a name="enforceCommentsProtection(java.lang.String, org.apache.poi.poifs.crypt.HashAlgorithm)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enforceCommentsProtection</h4>
<pre>public&nbsp;void&nbsp;enforceCommentsProtection(java.lang.String&nbsp;password,
                             <a href="../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a>&nbsp;hashAlgo)</pre>
<div class="block">Enforce the Comments protection.<br/>
 <br/>
 sample snippet from settings.xml
 <pre>
   &lt;w:documentProtection w:edit=&quot;comments&quot; w:enforcement=&quot;1&quot; 
       w:cryptProviderType=&quot;rsaAES&quot; w:cryptAlgorithmClass=&quot;hash&quot;
       w:cryptAlgorithmType=&quot;typeAny&quot; w:cryptAlgorithmSid=&quot;14&quot;
       w:cryptSpinCount=&quot;100000&quot; w:hash=&quot;...&quot; w:salt=&quot;....&quot;
   /&gt;
 </pre></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>password</code> - the plaintext password, if null no password will be applied</dd><dd><code>hashAlgo</code> - the hash algorithm - only md2, m5, sha1, sha256, sha384 and sha512 are supported.
   if null, it will default default to sha1</dd></dl>
</li>
</ul>
<a name="enforceTrackedChangesProtection()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enforceTrackedChangesProtection</h4>
<pre>public&nbsp;void&nbsp;enforceTrackedChangesProtection()</pre>
<div class="block">Enforce the Tracked Changes protection.<br/>
 In the documentProtection tag inside settings.xml file, <br/>
 it sets the value of enforcement to "1" (w:enforcement="1") <br/>
 and the value of edit to trackedChanges (w:edit="trackedChanges")<br/>
 <br/>
 sample snippet from settings.xml
 <pre>
     &lt;w:settings  ... &gt;
         &lt;w:documentProtection w:edit=&quot;trackedChanges&quot; w:enforcement=&quot;1&quot;/&gt;
 </pre></div>
</li>
</ul>
<a name="enforceTrackedChangesProtection(java.lang.String, org.apache.poi.poifs.crypt.HashAlgorithm)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enforceTrackedChangesProtection</h4>
<pre>public&nbsp;void&nbsp;enforceTrackedChangesProtection(java.lang.String&nbsp;password,
                                   <a href="../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a>&nbsp;hashAlgo)</pre>
<div class="block">Enforce the Tracked Changes protection.<br/>
 <br/>
 sample snippet from settings.xml
 <pre>
   &lt;w:documentProtection w:edit=&quot;trackedChanges&quot; w:enforcement=&quot;1&quot; 
       w:cryptProviderType=&quot;rsaAES&quot; w:cryptAlgorithmClass=&quot;hash&quot;
       w:cryptAlgorithmType=&quot;typeAny&quot; w:cryptAlgorithmSid=&quot;14&quot;
       w:cryptSpinCount=&quot;100000&quot; w:hash=&quot;...&quot; w:salt=&quot;....&quot;
   /&gt;
 </pre></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>password</code> - the plaintext password, if null no password will be applied</dd><dd><code>hashAlgo</code> - the hash algorithm - only md2, m5, sha1, sha256, sha384 and sha512 are supported.
   if null, it will default default to sha1</dd></dl>
</li>
</ul>
<a name="validateProtectionPassword(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateProtectionPassword</h4>
<pre>public&nbsp;boolean&nbsp;validateProtectionPassword(java.lang.String&nbsp;password)</pre>
<div class="block">Validates the existing password</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>password</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>true, only if password was set and equals, false otherwise</dd></dl>
</li>
</ul>
<a name="removeProtectionEnforcement()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeProtectionEnforcement</h4>
<pre>public&nbsp;void&nbsp;removeProtectionEnforcement()</pre>
<div class="block">Remove protection enforcement.<br/>
 In the documentProtection tag inside settings.xml file <br/>
 it sets the value of enforcement to "0" (w:enforcement="0") <br/></div>
</li>
</ul>
<a name="enforceUpdateFields()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enforceUpdateFields</h4>
<pre>public&nbsp;void&nbsp;enforceUpdateFields()</pre>
<div class="block">Enforces fields update on document open (in Word).
 In the settings.xml file <br/>
 sets the updateSettings value to true (w:updateSettings w:val="true")
 
  NOTICES:
  <ul>
   <li>Causing Word to ask on open: "This document contains fields that may refer to other files. Do you want to update the fields in this document?"
       (if "Update automatic links at open" is enabled)</li>
   <li>Flag is removed after saving with changes in Word </li>
  </ul></div>
</li>
</ul>
<a name="isTrackRevisions()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isTrackRevisions</h4>
<pre>public&nbsp;boolean&nbsp;isTrackRevisions()</pre>
<div class="block">Check if revision tracking is turned on.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if revision tracking is turned on</dd></dl>
</li>
</ul>
<a name="setTrackRevisions(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTrackRevisions</h4>
<pre>public&nbsp;void&nbsp;setTrackRevisions(boolean&nbsp;enable)</pre>
<div class="block">Enable or disable revision tracking.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>enable</code> - <code>true</code> to turn on revision tracking, <code>false</code> to turn off revision tracking</dd></dl>
</li>
</ul>
<a name="insertTable(int, org.apache.poi.xwpf.usermodel.XWPFTable)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>insertTable</h4>
<pre>public&nbsp;void&nbsp;insertTable(int&nbsp;pos,
               <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTable</a>&nbsp;table)</pre>
<div class="block">inserts an existing XWPFTable to the arrays bodyElements and tables</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#insertTable(int, org.apache.poi.xwpf.usermodel.XWPFTable)">insertTable</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html" title="interface in org.apache.poi.xwpf.usermodel">IBody</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - </dd><dd><code>table</code> - </dd></dl>
</li>
</ul>
<a name="getAllPictures()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllPictures</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFPictureData.html" title="class in org.apache.poi.xwpf.usermodel">XWPFPictureData</a>&gt;&nbsp;getAllPictures()</pre>
<div class="block">Returns all Pictures, which are referenced from the document itself.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>List</code> of <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFPictureData.html" title="class in org.apache.poi.xwpf.usermodel"><code>XWPFPictureData</code></a>. The returned <code>List</code> is unmodifiable. Use #a</dd></dl>
</li>
</ul>
<a name="getAllPackagePictures()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllPackagePictures</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFPictureData.html" title="class in org.apache.poi.xwpf.usermodel">XWPFPictureData</a>&gt;&nbsp;getAllPackagePictures()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>all Pictures in this package</dd></dl>
</li>
</ul>
<a name="addPictureData(byte[], int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPictureData</h4>
<pre>public&nbsp;java.lang.String&nbsp;addPictureData(byte[]&nbsp;pictureData,
                              int&nbsp;format)
                                throws <a href="../../../../../org/apache/poi/openxml4j/exceptions/InvalidFormatException.html" title="class in org.apache.poi.openxml4j.exceptions">InvalidFormatException</a></pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/poi/openxml4j/exceptions/InvalidFormatException.html" title="class in org.apache.poi.openxml4j.exceptions">InvalidFormatException</a></code></dd></dl>
</li>
</ul>
<a name="addPictureData(java.io.InputStream, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPictureData</h4>
<pre>public&nbsp;java.lang.String&nbsp;addPictureData(java.io.InputStream&nbsp;is,
                              int&nbsp;format)
                                throws <a href="../../../../../org/apache/poi/openxml4j/exceptions/InvalidFormatException.html" title="class in org.apache.poi.openxml4j.exceptions">InvalidFormatException</a></pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/poi/openxml4j/exceptions/InvalidFormatException.html" title="class in org.apache.poi.openxml4j.exceptions">InvalidFormatException</a></code></dd></dl>
</li>
</ul>
<a name="getNextPicNameNumber(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNextPicNameNumber</h4>
<pre>public&nbsp;int&nbsp;getNextPicNameNumber(int&nbsp;format)
                         throws <a href="../../../../../org/apache/poi/openxml4j/exceptions/InvalidFormatException.html" title="class in org.apache.poi.openxml4j.exceptions">InvalidFormatException</a></pre>
<div class="block">get the next free ImageNumber</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>format</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>the next free ImageNumber</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/poi/openxml4j/exceptions/InvalidFormatException.html" title="class in org.apache.poi.openxml4j.exceptions">InvalidFormatException</a></code></dd></dl>
</li>
</ul>
<a name="getPictureDataByID(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPictureDataByID</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFPictureData.html" title="class in org.apache.poi.xwpf.usermodel">XWPFPictureData</a>&nbsp;getPictureDataByID(java.lang.String&nbsp;blipID)</pre>
<div class="block">returns the PictureData by blipID</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>blipID</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>XWPFPictureData of a specificID</dd></dl>
</li>
</ul>
<a name="getNumbering()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumbering</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFNumbering.html" title="class in org.apache.poi.xwpf.usermodel">XWPFNumbering</a>&nbsp;getNumbering()</pre>
<div class="block">getNumbering</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>numbering</dd></dl>
</li>
</ul>
<a name="getStyles()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStyles</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFStyles.html" title="class in org.apache.poi.xwpf.usermodel">XWPFStyles</a>&nbsp;getStyles()</pre>
<div class="block">get Styles</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>styles for this document</dd></dl>
</li>
</ul>
<a name="getParagraph(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParagraph</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html" title="class in org.apache.poi.xwpf.usermodel">XWPFParagraph</a>&nbsp;getParagraph(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP&nbsp;p)</pre>
<div class="block">get the paragraph with the CTP class p</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#getParagraph(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP)">getParagraph</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html" title="interface in org.apache.poi.xwpf.usermodel">IBody</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>p</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>the paragraph with the CTP class p</dd></dl>
</li>
</ul>
<a name="getTable(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTable</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTable</a>&nbsp;getTable(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl&nbsp;ctTbl)</pre>
<div class="block">get a table by its CTTbl-Object</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#getTable(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl)">getTable</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html" title="interface in org.apache.poi.xwpf.usermodel">IBody</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>ctTbl</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>a table by its CTTbl-Object or null</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#getTable(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl)"><code>IBody.getTable(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl)</code></a></dd></dl>
</li>
</ul>
<a name="getTablesIterator()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTablesIterator</h4>
<pre>public&nbsp;java.util.Iterator&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTable</a>&gt;&nbsp;getTablesIterator()</pre>
</li>
</ul>
<a name="getParagraphsIterator()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParagraphsIterator</h4>
<pre>public&nbsp;java.util.Iterator&lt;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html" title="class in org.apache.poi.xwpf.usermodel">XWPFParagraph</a>&gt;&nbsp;getParagraphsIterator()</pre>
</li>
</ul>
<a name="getParagraphArray(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParagraphArray</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html" title="class in org.apache.poi.xwpf.usermodel">XWPFParagraph</a>&nbsp;getParagraphArray(int&nbsp;pos)</pre>
<div class="block">Returns the paragraph that of position pos</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#getParagraphArray(int)">getParagraphArray</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html" title="interface in org.apache.poi.xwpf.usermodel">IBody</a></code></dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#getParagraphArray(int)"><code>IBody.getParagraphArray(int)</code></a></dd></dl>
</li>
</ul>
<a name="getPart()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPart</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/POIXMLDocumentPart.html" title="class in org.apache.poi">POIXMLDocumentPart</a>&nbsp;getPart()</pre>
<div class="block">returns the Part, to which the body belongs, which you need for adding relationship to other parts
 Actually it is needed of the class XWPFTableCell. Because you have to know to which part the tableCell
 belongs.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#getPart()">getPart</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html" title="interface in org.apache.poi.xwpf.usermodel">IBody</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the Part, to which the body belongs</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#getPart()"><code>IBody.getPart()</code></a></dd></dl>
</li>
</ul>
<a name="getPartType()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPartType</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/BodyType.html" title="enum in org.apache.poi.xwpf.usermodel">BodyType</a>&nbsp;getPartType()</pre>
<div class="block">get the PartType of the body, for example
 DOCUMENT, HEADER, FOOTER, FOOTNOTE,</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#getPartType()">getPartType</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html" title="interface in org.apache.poi.xwpf.usermodel">IBody</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the PartType of the body</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#getPartType()"><code>IBody.getPartType()</code></a></dd></dl>
</li>
</ul>
<a name="getTableCell(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTc)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTableCell</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTableCell.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTableCell</a>&nbsp;getTableCell(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTc&nbsp;cell)</pre>
<div class="block">get the TableCell which belongs to the TableCell</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#getTableCell(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTc)">getTableCell</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html" title="interface in org.apache.poi.xwpf.usermodel">IBody</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - </dd></dl>
</li>
</ul>
<a name="getXWPFDocument()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getXWPFDocument</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html" title="class in org.apache.poi.xwpf.usermodel">XWPFDocument</a>&nbsp;getXWPFDocument()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#getXWPFDocument()">IBody</a></code></strong></div>
<div class="block">Return XWPFDocument</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#getXWPFDocument()">getXWPFDocument</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html" title="interface in org.apache.poi.xwpf.usermodel">IBody</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/XWPFDocument.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFComment.html" title="class in org.apache.poi.xwpf.usermodel"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFFactory.html" title="class in org.apache.poi.xwpf.usermodel"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/xwpf/usermodel/XWPFDocument.html" target="_top">FRAMES</a></li>
<li><a href="XWPFDocument.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li><a href="#field_summary">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li><a href="#field_detail">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
                <i>Copyright 2014 The Apache Software Foundation or
        its licensors, as applicable.</i>
            </small></p>
</body>
</html>
